/*
 *  JsonRpc-Cpp - JSON-RPC implementation.
 *  Copyright (C) 2008-2011 Sebastien Vincent <sebastien.vincent@cppextrem.com>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * \file jsonrpc_server.h
 * \brief JSON-RPC server.
 * \author Sebastien Vincent
 */

#ifndef JSONRPC_SERVER_H
#define JSONRPC_SERVER_H

#include "jsonrpc_common.h"
#include "jsonrpc_handler.h"

#include "networking.h"

namespace Json
{
namespace Rpc
{
/**
 * \class Server
 * \brief Abstract JSON-RPC server.
 */
class Server
{
public:
	/**
	 * \brief Constructor.
	 * \param address network address or FQDN to bind
	 * \param port local port to bind
	 */
	Server(const std::string& address, uint16_t port);

	/**
	 * \brief Destructor.
	 */
	virtual ~Server();

	/**
	 * \brief Wait message.
	 *
	 * This function do a select() on the socket and Process() immediately
	 * the JSON-RPC message.
	 * \param ms millisecond to wait (0 means infinite)
	 */
	virtual void WaitMessage(uint32_t ms) = 0;

	/**
	 * \brief Set the encapsulated format (default is RAW).
	 * \param format encapsulated format
	 */
	void SetEncapsulatedFormat(enum EncapsulatedFormat format);

	/**
	 * \brief Get the encapsulated format.
	 * \return encapsulated format
	 */
	enum EncapsulatedFormat GetEncapsulatedFormat() const;

	/**
	 * \brief Get socket descriptor.
	 * \return socket descriptor.
	 */
	int GetSocket() const;

	/**
	 * \brief Get the address.
	 * \return address or FQDN
	 */
	std::string GetAddress() const;

	/**
	 * \brief Get the port.
	 * \return local port
	 */
	uint16_t GetPort() const;

	/**
	 * \brief Bind the socket.
	 * \return true if success, false otherwise
	 */
	bool Bind();

	/**
	 * \brief Receive data from the network and process it.
	 * \param fd file descriptor on which receive
	 * \return true if message has been correctly received, processed and
	 * response sent, false otherwise (mainly send/receive error)
	 * \note This method will blocked until data comes.
	 */
	virtual bool Recv(int fd) = 0;

	/**
	 * \brief Close socket.
	 * \note It should be overriden for connection-oriented protocol
	 * like TCP to properly close all client sockets.
	 */
	virtual void Close();

	/**
	 * \brief Add a RPC method.
	 * \param method RPC method
	 */
	void AddMethod(CallbackMethod* method);

	/**
	 * \brief Delete a RPC method.
	 * \param method RPC method name
	 */
	void DeleteMethod(const std::string& method);

protected:
	/**
	 * \brief Copy constructor (private because of "resource" class).
	 * \param obj object to copy
	 */
	Server(const Server& obj);

	/**
	 * \brief Operator copy assignment (private because of "resource"
	 * class).
	 * \param obj object to copy
	 * \return copied object reference
	 */
	Server& operator=(const Server& obj);

	/**
	 * \brief Socket descriptor.
	 */
	int m_sock;

	/**
	 * \brief Transport protocol of the socket.
	 */
	enum networking::TransportProtocol m_protocol;

	/**
	 * \brief JSON-RPC handler.
	 */
	Handler m_jsonHandler;

private:
	/**
	 * \brief Network address or FQDN.
	 */
	std::string m_address;

	/**
	 * \brief Local port.
	 */
	uint16_t m_port;

	/**
	 * \brief Encapsulated format.
	 */
	enum EncapsulatedFormat m_format;
};
} /* namespace Rpc */
} /* namespace Json */

#endif /* JSONRPC_SERVER_H */

